Skip to content

Update CLAUDE.md with dev commands, architecture, and guidelines#1097

Merged
louis-pre merged 4 commits into
mainfrom
update-claude-md
Apr 23, 2026
Merged

Update CLAUDE.md with dev commands, architecture, and guidelines#1097
louis-pre merged 4 commits into
mainfrom
update-claude-md

Conversation

@louis-pre

@louis-pre louis-pre commented Apr 23, 2026

Copy link
Copy Markdown
Member

Summary

  • Renames claude.md to CLAUDE.md (standard casing)
  • Adds development commands (generate, format, lint, typecheck, validate-*)
  • Documents the 3-site GitBook architecture (guides, api-reference, brand-guides)
  • Documents the codegen pipeline (smith.ts, Metalsmith, Handlebars, @seamapi packages)
  • Clarifies auto-generated vs. hand-written content
  • Fixes stale references from /docs/api/ to docs/api-reference/
  • Adds guideline to avoid modifying file URLs in SUMMARY.md (use GitBook UI instead)
  • Preserves all existing writing conventions, patterns, and templates

Test plan

  • Verify Claude Code picks up the new CLAUDE.md correctly
  • Confirm no other files reference the old claude.md path

🤖 Generated with Claude Code

louis-pre and others added 2 commits April 23, 2026 13:41
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace the lengthy style guide with a focused reference that includes
build/lint/format commands, the 3-site GitBook architecture, codegen
pipeline details, and condensed writing conventions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@louis-pre louis-pre requested a review from a team as a code owner April 23, 2026 20:42
@louis-pre louis-pre changed the title Rewrite CLAUDE.md with dev commands and architecture chore: Rewrite CLAUDE.md with dev commands and architecture Apr 23, 2026
louis-pre and others added 2 commits April 23, 2026 13:55
…details

Keep all existing writing conventions, patterns, and guidelines intact.
Add new sections for:
- Development commands (generate, format, lint, validate-*)
- Three GitBook sites (guides, api-reference, brand-guides)
- Codegen pipeline (smith.ts, Metalsmith, Handlebars, @seamapi packages)
- Auto-generated vs. hand-written content guidance

Fix stale references from /docs/api/ to docs/api-reference/.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Use the GitBook UI to rename or move pages instead, as modifying
URLs via SUMMARY.md can break GitBook sync.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@louis-pre louis-pre changed the title chore: Rewrite CLAUDE.md with dev commands and architecture Update CLAUDE.md with dev commands, architecture, and guidelines Apr 23, 2026
@louis-pre louis-pre merged commit fd75ea8 into main Apr 23, 2026
10 checks passed
@louis-pre louis-pre deleted the update-claude-md branch April 23, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant